Merciful 5/Merciful - Disc 5.iso/software/h/hypertextdatav40.12cr.lha/HTDS/Docs/productinfo.hguide

Amiga HyperGuide | 1997-03-31 | 25.9 KB | 626 lines

@hyperguide productinfo.hguide
@$VER: productinfo.hguide 40.2 (26.03.97)
@macro m_prg "@{b}ProductInfo DataType@{ub}"
@macro m_field "@{\" $1 \" link Fields_$1}@{tab}"
@include htds.hgm

@node main "ProductInfo DataType Documentation"
@toc HTDS.hguide/main
@prev directory.hguide/main
@next man.hguide/main

@{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}

@{settabs 30}
@{m_sec Menu}
@{m_menuitem}@{" Configuration " link Configuration                }@{m_menuinfo "Adapt to your needs"}
@{m_menuitem}@{" Fields "        link Fields                       }@{m_menuinfo "supported ProductInfo fields"}
@{m_menuitem}@{" Attributes "    link hypertext.hguide/CommonAttrs }@{m_menuinfo "Using HyperGuide attributes"}
@{m_menuitem}@{" Base Datatype " link hypertext.hguide/main        }@{m_menuinfo "The HyperText Datatype"}
@{line}
@{m_menuitem}@{" Copyright "     link HTDS.hguide/Copyright        }@{m_menuinfo "legal stuff"}
@{m_menuitem}@{" Author "        link SR.hguide/Addresses          }@{m_menuinfo "how to contact me"}
@{m_menuitem}@{" Registration "  link HTDS.hguide/Registration     }@{m_menuinfo "It's Shareware !!!"}
@{m_endsec}

@endnode
@node Configuration "ProductInfo/Configuration"

@{m_sec "Configuration"}
As the recommended standard for datatypes, the preference file for the
productinfo.datatype is called @{m_file productinfo.prefs} and is searched first in
the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
The following options are currently available using ReadArgs() argument parsing :


@{definition}
FIELD/S/A,FORMAT/K,INDENT/N/K
@{defterm}FIELD
@{defdata}indicates that the following format and indent specification is used
for @{"ProductInfo field" link Fields} names.

@{defterm}FORMAT
@{defdata}is used to specify the text font, style and color for the field name.
You can use any @{"common"link hypertext.hguide/CommonAttrs} @{hyperguide} attribute.
@{line}Default is "@{b}".

@{defterm}INDENT
@{defdata}is used to specify the number of spaces to indent the field name.
@{line}Default is 3.

@{enddefinition}

@{definition}
TEXT/S/A,FORMAT/K,INDENT/N/K
@{defterm}TEXT
@{defdata}indicates that the following format and indent specification is used
for the text section of @{"ProductInfo fields" link Fields}.

@{defterm}FORMAT
@{defdata}is used to specify the text font, style and color for the text section.
You can use any @{"common"link hypertext.hguide/CommonAttrs} @{hyperguide} attribute.
@{line}Default is "".

@{defterm}INDENT
@{defdata}is used to specify the number of spaces to indent the field name.
@{line}Default is 6.

@{enddefinition}

@{definition}
FIELDSEQ/S/A,FIELDS/M/A

@{defterm}FIELDSEQ
@{defdata}indicates that the following data defines the @{"ProductInfo fields" link Fields} order.

@{defterm}FIELDS
@{defdata}defines the order of the @{"ProductInfo fields" link Fields}.
@{line}Default is :
@{enumerate}
@{item}@{"name"         link Fields_name}
@{item}@{"fullname"     link Fields_fullname}
@{item}@{"type"         link Fields_type}
@{item}@{"short"        link Fields_short}
@{item}@{"description"  link Fields_description}
@{item}@{"version"      link Fields_version}
@{item}@{"date"         link Fields_date}
@{item}@{"author"       link Fields_author}
@{item}@{"restrictions" link Fields_restrictions}
@{item}@{"requirements" link Fields_requirements}
@{item}@{"reference"    link Fields_reference}
@{item}@{"distribution" link Fields_distribution}
@{item}@{"price"        link Fields_price}
@{item}@{"address"      link Fields_address}
@{item}@{"email"        link Fields_email}
@{item}@{"exectype"     link Fields_exectype}
@{item}@{"installsize"  link Fields_installsize}
@{item}@{"source"       link Fields_source}
@{item}@{"construction" link Fields_construction}
@{item}@{"tested"       link Fields_tested}
@{item}@{"run"          link Fields_run}
@{item}@{"docs"         link Fields_docs}
@{item}@{"described-by" link Fields_described-by}
@{item}@{"submittal"    link Fields_submittal}
@{item}@{"stored-in"    link Fields_stored-in}
@{endenumerate}
@{enddefinition}

@{m_endsec}
@endnode
@node Fields "ProductInfo/Fields"

@{m_sec "Fields"}
The following are the fields defined by the Product-Info Specification v6
as designed by Fred Fish and Udo Schuermann. The fields docmentation was
grabbed from the VPI.guide (Thomas Igracki) . Thanks Thomas for the
permission.

@{settabs 20 40 60 80 100}

@{m_field "address"}
@{m_field "author"}
@{m_field "construction"}
@{m_field "date"}
@{m_field "described-by"}
@{m_field "description"}
@{m_field "distribution"}
@{m_field "docs"}
@{m_field "email"}
@{m_field "exectype"}
@{m_field "fullname"}
@{m_field "installsize"}
@{m_field "name"}
@{m_field "price"}
@{m_field "reference"}
@{m_field "requirements"}
@{m_field "restrictions"}
@{m_field "run"}
@{m_field "short"}
@{m_field "source"}
@{m_field "stored-in"}
@{m_field "submittal"}
@{m_field "tested"}
@{m_field "type"}
@{m_field "version"}
@{cleartabs}

@{m_endsec}
@endnode

@node Fields_name "ProductInfo/Fields/.name"
@{code}

@{fg shine}@{b}@{u}.name:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      The program's name
      @{b}FORMAT:@{ub}       1 line only
      @{b}EXAMPLE:@{ub}      KingFisher
      @{b}EXAMPLE:@{ub}      HomeBase VI
      @{b}EXAMPLE:@{ub}      AIBB
      @{b}EXAMPLE:@{ub}      gcc
@endnode
@node Fields_fullname "ProductInfo/Fields/.fullname"
@{code}

@{fg shine}@{b}@{u}.fullname:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      The program's full (or complete) name
      @{b}FORMAT:@{ub}       1 line only
      @{b}EXAMPLE:@{ub}      Amiga Intuition Based Benchmarks
      @{b}EXAMPLE:@{ub}      GNU C Compiler
      @{b}NOTES:@{ub}        If the .name is not an abbreviation then omit the
            .fullname.  No sense in giving the name twice!
@endnode
@node Fields_type "ProductInfo/Fields/.type"
@{code}

@{fg shine}@{b}@{u}.type:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      A keyword that describes the nature of the program
      @{b}FORMAT:@{ub}       Preferrably a single word or two.
      @{b}EXAMPLE:@{ub}      Database
      @{b}EXAMPLE:@{ub}      Spreadsheet
      @{b}EXAMPLE:@{ub}      Animation Player
      @{b}EXAMPLE:@{ub}      Animation Tools
      @{b}EXAMPLE:@{ub}      Communications
      @{b}EXAMPLE:@{ub}      Display Commodity
      @{b}EXAMPLE:@{ub}      Mouse Commodity
      @{b}NOTES:@{ub}        Avoid abbreviations.  Refer to the list below for
            suggestions.
@endnode
@node Fields_short "ProductInfo/Fields/.short"
@{code}

@{fg shine}@{b}@{u}.short:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      A one-line description, preferrably not exceeding
            40 characters in length.  This description is to
            give a single-glance insight into the program's
            purpose.
      @{b}FORMAT:@{ub}       1 line only.
      @{b}EXAMPLE:@{ub}      Software catalog/search/maintenance tool, multi-user.
@endnode
@node Fields_description "ProductInfo/Fields/.description"
@{code}

@{fg shine}@{b}@{u}.description:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      A full-text description of your program, containing
            anything that is NOT ALREADY available through the
            other fields (see above and below.)  The reader
            should gain a good understanding what your program
            can and cannot do.  If you mention other programs
            please do not forget to provide a .reference field
            for each such mention.
      @{b}FORMAT:@{ub}       Any number of lines, treated as one line.
            Formatting is permitted, but generally discouraged.
      @{b}NOTES:@{ub}        Do not indent your text if you choose to format
            your text into multiple paragraphs.  Do not use t
            as a tab.  Leave paragraph formatting to KingFisher.
@endnode
@node Fields_version "ProductInfo/Fields/.version"
@{code}

@{fg shine}@{b}@{u}.version:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      The program's version number
      @{b}FORMAT:@{ub}       MAJOR.MINOR
            1 line only
      @{b}EXAMPLE:@{ub}      37.100
      @{b}NOTES:@{ub}        Please note that the Commodore guidelines specify
            that the number after the period is NOT a FRACTION
            but rather a WHOLE NUMBER!  Thus, the following is
            a valid progression:
            37.1  37.17  37.39  37.100  37.170
            The following are all vastly different versions:
            37.1  37.10  37.100  37.1000
      @{b}NOTES:@{ub}        The format given for this field is really more of a
            SUGGESTION rather than a RULE.  There is no reason
            why you can't store "Today's Version" or "v940205"
            instead of 18.173.  In an ideal world everyone
            would use Commodore guidelines, but there are
            enough exceptions.
@endnode
@node Fields_date "ProductInfo/Fields/.date"
@{code}

@{fg shine}@{b}@{u}.date:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      The program's official release date; not the date
            it made it into the database.
      @{b}FORMAT:@{ub}       year.month.day
            1 line only
      @{b}EXAMPLE:@{ub}      1993.09.27
      @{b}NOTES:@{ub}        The date format is chosen to be easily sortable.
            Note the use of leading zeros in month and day.
            The full year is to be given in anticipation of
            the coming change to a new millenium.
@endnode
@node Fields_author "ProductInfo/Fields/.author"
@{code}

@{fg shine}@{b}@{u}.author:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      Any and all authors who have a part in the program
      @{b}FORMAT:@{ub}       Any number of lines, treated as one line (n in the
            text will "break up" the line into multiple visual
            lines.)
      @{b}EXAMPLE:@{ub}      Joe R. User, Tea Rexx.
      @{b}EXAMPLE:@{ub}      J. Jonesn
            Random Hackern
            B. Clinton
      @{b}NOTES:@{ub}        Addresses should be placed in the .address field.
            There should be only one .address field for each
            .author field.
            If more than 1 .author field is specified, then the
            same number of .address and .email fields must also
            be given in a 1-to-1 relationship (i.e. the 3rd
            .author field must be associated with the 3rd
            .address, and the 3rd .email field.)
            EX: see the example "Joe R. User, Tea Rexx" above;
            Assume that Joe R. User has long vanished and no
            known address, but that Tea Rexx has supported the
            program for a while.  If an .address and/or .email
            field is available for Tea Rexx, then you must
            specify EMPTY .address and/or .email fields for the
            author listed BEFORE the ones for Tea Rexx.
            Likewise, if the two authors names were reversed,
            you would NOT have to specify blank .address and/or
            .email fields for the second author.  I hope that
            makes sense.
@endnode
@node Fields_restrictions "ProductInfo/Fields/.restrictions"
@{code}

@{fg shine}@{b}@{u}.restrictions:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      List restrictions placed upon this program.  These
            should indicate in which way this program has been
            made dysfunctional (for demo purposes), problems
            (bugs) known to exist with this program, or any
            other thing that lets the user know that this
            program, as seen in this distribution, may not
            fully satisfy the user in some form.
      @{b}FORMAT:@{ub}       Free form; see .description for more info.
      @{b}EXAMPLE:@{ub}      Demo version has SAVE and PRINT options disabled.
      @{b}EXAMPLE:@{ub}      The ReadOperatorsMind command fails to work with
            CDTV units.  Incompatible with the Discus Ejector
            utility.
      @{b}EXAMPLE:@{ub}      Crashes if iconified while loading a sample or
            image larger than 64K.
      @{b}EXAMPLE:@{ub}      Requires a PAL display.
      @{b}EXAMPLE:@{ub}      The program is in German but the documentation
            offers translations into English and Swahili on
            a menu-by-menu and gadget-by-gadget basis.
      @{b}NOTES:@{ub}        Do NOT use this field for things like "won't work
            with KS 1.3" or "won't run with less than 2 Megs
            of RAM."
@endnode
@node Fields_requirements "ProductInfo/Fields/.requirements"
@{code}

@{fg shine}@{b}@{u}.requirements:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      List requirements for your program.  These should
            give the reader enough information to determine if
            the software will run on his/her system or not.
            Be sure to specify operating system versions,
            (hard)disk space requirements, etc.  If your
            program requires any external libraries that are
            not part of the system software, it would be nice
            to list them here and comment on whether or not
            they are included in the archive.
            If your program is known to run on every existing
            (Amiga) platform, state this in this field!
      @{b}FORMAT:@{ub}       Free form; see .description for more info.
      @{b}EXAMPLE:@{ub}      68020, 68030, or 68040 CPU; 3M free RAM; 18M disk
            space; at least 640x480 display capabilities!
      @{b}EXAMPLE:@{ub}      Requires WB2.1 (V38)
      @{b}EXAMPLE:@{ub}      Requires 1024x768 (or larger) display capability.
      @{b}EXAMPLE:@{ub}      Works only with 4096-channel, 230db BLAZETHUNDER
            Audio board.
      @{b}EXAMPLE:@{ub}      Requires MUI (MagicUserInterface) version 5.
@endnode
@node Fields_reference "ProductInfo/Fields/.reference"
@{code}

@{fg shine}@{b}@{u}.reference:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Full path to where this program's files are stored,
            as well as the version that is stored there.
      @{b}FORMAT:@{ub}       2 lines per reference:  the first line specifies
            the full path (with trailing slash) and the second
            line, the version.
      @{b}NOTES:@{ub}        Multiple such fields may be provided to reference
            previous versions of this program, as well as
            other programs that might be of interest.  The
            versions should be listed in reverse chronological
            order and SHOULD include the CURRENT entry.
            Please note that it is VERY VERY VERY important
            that you specify the CORRECT PATH!  Without a
            correct path, this entry will be nearly useless!
            SPECIFY THE PATH WITH A NEW SUBMISSION ONLY IF YOU
            KNOW WHERE IT IS STORED; NEW SUBMISSIONS WILL HAVE
            A PATH ASSIGNED HERE AUTOMATICALLY.  YOU SHOULD
            PROVIDE THE PROPER PATHS TO KNOWN AND EXISTING
            SOFTWARE.
      @{b}EXAMPLE:@{ub}      FishROM-0002:Productivity/Databases/HomeBase VI/
            417.0
            FishROM-0001:Productivity/Databases/HomeBase VI/
            415.12
@endnode
@node Fields_distribution "ProductInfo/Fields/.distribution"
@{code}

@{fg shine}@{b}@{u}.distribution:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describes the distribution and ownership status
            of this software.  Please see below for a list of
            common (and recommended!) terms to use.
      @{b}FORMAT:@{ub}       1 line
      @{b}EXAMPLE:@{ub}      Shareware
      @{b}NOTES:@{ub}        Please see the table below for descriptions of the
            recommended terms.
@endnode
@node Fields_price "ProductInfo/Fields/.price"
@{code}

@{fg shine}@{b}@{u}.price:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describes the cost of this program to the user.
      @{b}FORMAT:@{ub}       Any number of lines, treated as one line.
      @{b}EXAMPLE:@{ub}      $50(US), DM75.
      @{b}NOTES:@{ub}        In order to make this field more useful, it is
            STRONGLY recommended that the FIRST currency
            listed is United States Dollars as shown in the
            EXAMPLE above.  This allows a search to be limited
            to a common price base.  If you charge no money
            for this program, omit this field!
@endnode
@node Fields_address "ProductInfo/Fields/.address"
@{code}

@{fg shine}@{b}@{u}.address:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describe a full postal address of the author, to
            be used if it becomes necessary or desirable to
            contact the author.  Do not specify the author's
            name, as this is already in the .author field.
      @{b}FORMAT:@{ub}       Multiple lines; formatting symbols n are not
            required, as physical line breaks are equivalent.
      @{b}NOTES:@{ub}        SEE THE .author FIELD FOR IMPORTANT INFORMATION
@endnode
@node Fields_email "ProductInfo/Fields/.email"
@{code}

@{fg shine}@{b}@{u}.email:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describe a full electronic mail address.  Make
            sure that this address is complete and reachable
            even from less well-connected sites.  The author
            of KingFisher, for example, can be reached as
            [e-mail]
            It would be an error to specify only "walrus" or
            "walrus@wam" even though these will work within
            the particular organization where this address
            is valid.
      @{b}FORMAT:@{ub}       Multiple lines; formatting symbols n are not
            required, as physical line breaks are equivalent.
            Do not specify more than one email address per
            line.  The more you abide by RFC-822 specifications
            the better.
      @{b}EXAMPLES:@{ub}     [e-mail] (Udo Schuermann)
            Udo Schuermann <[e-mail]>
            "Udo Schuermann" <[e-mail]>
            <[e-mail]> Udo Schuermann
      @{b}NOTES:@{ub}        You may specify multiple electronic mail addresses
            in order of decreasing reliability and permanence,
            each on its own line.
            SEE THE .author FIELD FOR IMPORTANT INFORMATION
@endnode
@node Fields_exectype "ProductInfo/Fields/.exectype"
@{code}

@{fg shine}@{b}@{u}.exectype:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describe the type of executable(s) that make up
            your program.  Examples:  68xxx, AMOS, Script,
            ARexx, Compiled basic, Amigabasic, etc.
      @{b}FORMAT:@{ub}       Free form; see .description for more information.
      @{b}EXAMPLE:@{ub}      AMOS
      @{b}EXAMPLE:@{ub}      68000, 68020, and 68040.
      @{b}EXAMPLE:@{ub}      Compiled BASIC
      @{b}EXAMPLE:@{ub}      Compiled ARexx
      @{b}NOTES:@{ub}        AMOS-based software has been said to not work on
            some systems at all; this entry allows a user to
            determine if the software is worth obtaining in the
            first place.
@endnode
@node Fields_installsize "ProductInfo/Fields/.installsize"
@{code}

@{fg shine}@{b}@{u}.installsize:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Indicate the minimum and maximum sizes of the
            executable as it is installed.  The minimum size
            should give an indication of how much diskspace
            is required for a minimal installation (perhaps
            lacking help files and miscellaneous tools) while
            the maximum size should indicate the absolutely
            highest amount of diskspace required by the
            program.
      @{b}FORMAT:@{ub}       1 or more lines; Only the first line has a fixed
            format, the rest are free-form.  See examples.
            Always indicate the number scales with a capital
            K (for kilobyte) or M (for megabyte)
      @{b}EXAMPLE:@{ub}      220K - 2M
            Most of the database files can be kept on floppy
            disks, so valuable harddisk space is not wasted.
      @{b}EXAMPLE:@{ub}      18K
      @{b}EXAMPLE:@{ub}      38K - 500K
            Lots of documentation and example scripts make up
            the bulk of the installation.
@endnode
@node Fields_source "ProductInfo/Fields/.source"
@{code}

@{fg shine}@{b}@{u}.source:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describe what source code is available with this
            program.  If source code is not available then
            omit this field.  The .construction field often
            helps further identify the type of source if you
            omit details here.  How large is the source?
      @{b}FORMAT:@{ub}       Free form; see .description for more information.
      @{b}EXAMPLE:@{ub}      SAS/C,Manx,DICE source (750K) available for $15
      @{b}EXAMPLE:@{ub}      Oberon source included.  85K
      @{b}EXAMPLE:@{ub}      Limited C source (15K) included.
      @{b}EXAMPLE:@{ub}      All source plus custom libraries, included: 12MB
@endnode
@node Fields_construction "ProductInfo/Fields/.construction"
@{code}

@{fg shine}@{b}@{u}.construction:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Describe the type of language(s) used to create
            this program and the methods used to build the
            final executable.  If possible, include the
            compiler version(s) and possibly important
            options, such as optimization.
      @{b}FORMAT:@{ub}       Free form; see .description for more information.
      @{b}EXAMPLE:@{ub}      SAS/C++ 6.5 with full optimization.
      @{b}EXAMPLE:@{ub}      AdaEd.
      @{b}EXAMPLE:@{ub}      Fortran with self-made compiler.
      @{b}EXAMPLE:@{ub}      AMOS
      @{b}NOTES:@{ub}        This is usually closely related to the .exectype
            field but differs from it in that the .exectype
            might be "Compiled C" but the compiler used was
            "RottenC 0.97"
@endnode
@node Fields_tested "ProductInfo/Fields/.tested"
@{code}

@{fg shine}@{b}@{u}.tested:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Give an indication of which configurations have
            served as test environments.
      @{b}FORMAT:@{ub}       Free form; see .description for more information.
      @{b}EXAMPLE:@{ub}      A500(512K Chip, 0K Fast, 1 Floppy), A2000(1M Chip,
            2M Fast, 40M HD, 1 Floppy); not tested on 68020+
            CPUs.
      @{b}EXAMPLE:@{ub}      A1000, A500, A600, A2000, A2000/30, A3000, A1200,
            A4000/30, A4000/40 with various amounts of Chip
            and Fast RAM, with and without MMU or FPU.  Found
            to be free of Enforcer hits and able to work with
            virtual memory products; compatible with Retina,
            EGS/Spectrum, and Picasso software.  Also tested
            under V33 through V40 system software.
@endnode
@node Fields_run "ProductInfo/Fields/.run"
@{code}

@{fg shine}@{b}@{u}.run:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Specifies how to start the program.
      @{b}FORMAT:@{ub}       visible=type,command
            Where 'type' is either WB or CLI to indicate the
            required startup environment.
      @{b}EXAMPLE:@{ub}      HomeBase VI=WB,HomeBase VI
            HomeBase VI=CLI,ExecuteMe.HB6
            HomeBase VI Fixer=CLI,ExecuteMe.HB6Fixer
      @{b}EXAMPLE:@{ub}      FishTub=WB,ExecuteMe
      @{b}NOTES:@{ub}        KingFisher requires that this entry strictly
            follows the above format.
            The user is shown all text up to the first equal
            sign (the 'visible' portion.)  The 'type' portion
            must be terminated with a comma (,) and following
            it will be the command to be executed.
            Selecting it will either invoke the program from
            the Workbench (invoking it as if double clicked on
            its icon (if the .info file exists), or execute the
            indicated shell command line as if it has been
            typed at an open console window.
@endnode
@node Fields_docs "ProductInfo/Fields/.docs"
@{code}

@{fg shine}@{b}@{u}.docs:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}    List all documentation files, possibly for viewing
          from within KingFisher for more detailed info.
      @{b}FORMAT:@{ub}     1 line per file
      @{b}EXAMPLE:@{ub}    HomeBase.guide
          HomeBase.dvi
          HomeBase.doc
      @{b}NOTES:@{ub}      KingFisher examines the EXTENSION and invokes the
          appropriate viewing tool: MultiView/AmigaGuide for
          .guide files, ShowDVI for .dvi files, more for
          anything else.  These files can also be sent to the
          printer via KingFisher (i.e. print .ps or .doc
          files.)  KingFisher will honor the PAGER
          environment variable (defaults to 'more') to
          display standard text.
      @{b}NOTES:@{ub}      Omit any path to these files, unless it is a
          relative path from within the program's CD-ROM or
          disk directory.  Do not specify these files if
          they are located within archive files; remember:
          the files must exist as they are given here!
@endnode
@node Fields_described-by "ProductInfo/Fields/.described-by"
@{code}

@{fg shine}@{b}@{u}.described-by:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Specifies who created the description (Product-Info
            file) for the program.
      @{b}FORMAT:@{ub}       Free form; should include an electronic mail
            address, too, if available.
      @{b}EXAMPLE:@{ub}      Fred Fish ([e-mail])
      @{b}EXAMPLE:@{ub}      Udo Schuermann <[e-mail]>

@endnode
@node Fields_submittal "ProductInfo/Fields/.submittal"
@{code}

@{fg shine}@{b}@{u}.submittal:@{uu}@{ub}@{fg text}
      @{fg fill}<<<OPTIONAL>>>@{fg text}
      @{b}PURPOSE:@{ub}      Identifies who submitted the program to Fred or
            else how this program came to be on the reference
            disk.
      @{b}FORMAT:@{ub}       Free form; usually one line.
      @{b}EXAMPLE:@{ub}      Submitted on disk directly by the author.
      @{b}EXAMPLE:@{ub}      Downloaded from wuarchive.wustl.edu in pub/aminet/util/misc
@endnode
@node Fields_stored-in "ProductInfo/Fields/.stored-in"
@{code}

@{fg shine}@{b}@{u}.stored-in:@{uu}@{ub}@{fg text}
      @{b}PURPOSE:@{ub}      Specifies where and especially HOW the application
            is stored.  This field should specify EITHER the
            name of a directory (ending with a : or a /) OR the
            name of a file (one that does NOT end with : or /)
      @{b}FORMAT:@{ub}       1 or more lines.
      @{b}EXAMPLE:@{ub}      FF1000:Disks701-1000/Disks941-960/Disk950/Enforcer/
            FF1000:BBS/Disks501-1000/Disks941-960/Disk950/Enforcer.lha
      @{b}NOTES:@{ub}        It is up to the particular application to decide
            how to handle this information.  If the extension
            on the file is .lha, .lzh, .Z, .zoo, .pak, .zip,
            etc. then you could, for example, call upon the
            archiver of choice to unpack the application into a
            temporary directory and let the user run the
            program or list the files, or whatever.
@endnode